Propose API improvements to Calendar #321
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
parkera
force-pushed
the
parkera/swift_calendar_improvements
branch
from
39108a6 to
c4f166c
Compare
Merged
parkera
force-pushed
the
parkera/swift_calendar_improvements
branch
from
c4f166c to
0d4b4ad
Compare
Harry-KNIGHT
suggested changes
Dec 5, 2023
| ```swift | ||
| extension Calendar { | ||
| public enum Component : Sendable { | ||
| // .. existing fields |
There was a problem hiding this comment.
Is it a useful commentary ?
Suggested change
| // .. existing fields |
There was a problem hiding this comment.
I do this so it's clear we are not adding this Component type as part of this proposal.
Comment on lines
65
to
70
| public func dates(startingAt start: Date, | ||
| in range: Range<Date>? = nil, | ||
| matching components: DateComponents, | ||
| matchingPolicy: MatchingPolicy = .nextTime, | ||
| repeatedTimePolicy: RepeatedTimePolicy = .first, | ||
| direction: SearchDirection = .forward) -> some (Sequence<Date> & Sendable) |
There was a problem hiding this comment.
Indentation, ctrl + M
Suggested change
| public func dates(startingAt start: Date, | |
| in range: Range<Date>? = nil, | |
| matching components: DateComponents, | |
| matchingPolicy: MatchingPolicy = .nextTime, | |
| repeatedTimePolicy: RepeatedTimePolicy = .first, | |
| direction: SearchDirection = .forward) -> some (Sequence<Date> & Sendable) | |
| public func dates( | |
| startingAt start: Date, | |
| in range: Range<Date>? = nil, | |
| matching components: DateComponents, | |
| matchingPolicy: MatchingPolicy = .nextTime, | |
| repeatedTimePolicy: RepeatedTimePolicy = .first, | |
| direction: SearchDirection = .forward) -> some (Sequence<Date> & Sendable | |
| ) |
There was a problem hiding this comment.
In Foundation code we don't typically split the arguments from the first line.
Comment on lines
88
to
92
| public func dates(startingAt start: Date, | ||
| in range: Range<Date>? = nil, | ||
| byAdding component: Calendar.Component, | ||
| value: Int = 1, | ||
| wrappingComponents: Bool = false) -> some (Sequence<Date> & Sendable) |
There was a problem hiding this comment.
Same here, ctrl + m
Suggested change
| public func dates(startingAt start: Date, | |
| in range: Range<Date>? = nil, | |
| byAdding component: Calendar.Component, | |
| value: Int = 1, | |
| wrappingComponents: Bool = false) -> some (Sequence<Date> & Sendable) | |
| public func dates( | |
| startingAt start: Date, | |
| in range: Range<Date>? = nil, | |
| byAdding component: Calendar.Component, | |
| value: Int = 1, | |
| wrappingComponents: Bool = false) -> some (Sequence<Date> & Sendable | |
| ) |
Comment on lines
103
to
106
| public func dates(startingAt start: Date, | ||
| in range: Range<Date>? = nil, | ||
| byAdding components: DateComponents, | ||
| wrappingComponents: Bool = false) -> some (Sequence<Date> & Sendable) |
There was a problem hiding this comment.
Suggested change
| public func dates(startingAt start: Date, | |
| in range: Range<Date>? = nil, | |
| byAdding components: DateComponents, | |
| wrappingComponents: Bool = false) -> some (Sequence<Date> & Sendable) | |
| public func dates( | |
| startingAt start: Date, | |
| in range: Range<Date>? = nil, | |
| byAdding components: DateComponents, | |
| wrappingComponents: Bool = false | |
| ) -> some (Sequence<Date> & Sendable) |
parkera
force-pushed
the
parkera/swift_calendar_improvements
branch
from
35a0a7e to
14e972f
Compare
itingliu
approved these changes
Dec 19, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In macOS 14 / iOS 17,
Calendarwas rewritten entirely in Swift. One of the many benefits of this change is that we can now more easily create Swift-specificCalendarAPI that feels more natural than the existingenumeratemethods. In addition, we are taking the opportunity to add a new field to theDateComponentstype to handle one case that was only exposed via the somewhat esoteric CoreFoundation APICFCalendarDecomposeAbsoluteTime.